Remove-RASScheduleMessage

NAME

Remove-RASScheduleMessage

SYNOPSIS

Removes a Schedule Message from a Schedule Item.

SYNTAX

Remove-RASScheduleMessage [-Id] <uint> -MessageId <uint> -ObjType {RDS | VDI | AVD} [-TargetType {Host | HostPool}] [<CommonParameters>]

Remove-RASScheduleMessage [-Name] <string> [[-SiteId] <uint>] -MessageId <uint> -ObjType {RDS | VDI | AVD} [-TargetType {Host | HostPool}] [<CommonParameters>]

DESCRIPTION

Removes a Schedule Message from a Schedule Item.

PARAMETERS


-MessageId <uint>
Scheduler job message ID. 

        Required?                    true
        Position?                    named
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Name <string>
Scheduler job name. 

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-SiteId <uint>
Site ID to modify the schedule job. 

        Required?                    false
        Position?                    1
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Id <uint>
Scheduler job ID. 

        Required?                    true
        Position?                    0
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-ObjType <ScheduleObjType>
Schedule message object type.

Possible values: RDS, VDI, AVD 

        Required?                    true
        Position?                    named
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-TargetType <ScheduleTargetType>
Schedule target type.

Possible values: Host, HostPool 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

<CommonParameters> 
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see 
        about_CommonParameters documentation.

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES


---------- EXAMPLE 1 ----------

Remove-RASScheduleMessage -objType vdi -Name "SchedItem" -MessageId 1

Removes the specified message by id within the specified schedule item by name.
---------- EXAMPLE 2 ----------

Remove-RASScheduleMessage -objType vdi -Id 1 -MessageId 1

Removes the specified message by id within the specified schedule item by id.

RELATED LINKS